Skip to content

/meta_info

一些下拉菜单之类的地方需要的数据,因为不同页面需要的数据不同但是又有些重合,所以把这类数据放在一个接口里,前端可以通过 request 来决定需要哪些数据

method
    GET
request
    // response 里是否返回相关的字段,默认 false
    partners                O   bool (0 或 1)
    station_types           O   bool (0 或 1)
    ma_permissions          O   bool (0 或 1)
    station_permissions     O   bool (0 或 1)
    cities                  O   bool (0 或 1)
    stations                O   bool (0 或 1)
    available_partners       O   bool (0 或 1)
    vaild_partners          O    bool
response
    {
        data: {
            partners: [
                {
                    id:     int M
                    name:   str M
                }
            ],
            available_partners: [
                {
                    id:     int M
                    name:   str M
                }
            ],
            valid_partners: [
                {
                    id:   int M
                    name:  str M
                }
            ]
            station_types: [
                {
                    id:     int M
                    name:   str M
                }
            ],
            ma_permissions: {  // 新建 加盟商 的时候可以选择的所有权限
                1: {                                // level 1 id
                    "id": 1,                        // level 1 id
                    "name": "部门"                    // level 1 name
                    "content": {
                        4: {                        // level 2 id
                            "id": 4,                // level 2 id
                            "permission": {
                                10: "增加部门",     // permission id & name
                            }
                        }
                    }
                }
            },
            station_permissions: {  // 新建 站点 的时候可以选择的所有权限
                1: {                                // level 1 id
                    "id": 1,                        // level 1 id
                    "name": "部门"                    // level 1 name
                    "content": {
                        4: {                        // level 2 id
                            "id": 4,                // level 2 id
                            "permission": {
                                10: "增加部门",     // permission id & name
                            }
                        }
                    }
                }
            },
            cities: [
                {
                    code:   int M
                    name:   str M
                }
            ],
            stations: [     // 某个加盟商下的所有站点
                {
                    id:     str M
                    name:   str M
                }
            ]
        },
        msg: 'OK',
        code: 0,
    }

加盟商管理,按照加盟商查看

/partner/search

搜索加盟商

method
    GET
request
    is_valid    bool            O (0 或 1)
    search_text str             O
    offset      int             M  default 0
    limit       int             M  default 10
response
    {
        data: 
            [
               {
                id:             int             M
                name:           str             M
                stations:       list of string  M
                description:    str             M
                create_date:    str             M
                is_valid:       bool            M
               },
               ...
            ]
        ],
        msg: 'OK',
        code: 0,

/partner/detail

加盟商详情

method
    GET
request
    id  int M
response
    {
        data: {
            name            M   str
            description     M   str
            is_valid        M   bool
            permission_ids  M   list of int 已经激活的权限 id
        },
        msg: 'OK',
        code: 0,
    }

/partner/create

创建加盟商

method
    POST
request
    name            M   int
    description     M   int
    is_valid        M   bool (0 或 1)
    permission_ids  M   list of int 激活的权限 id
response
    {
        data: { 'partner_id': 123 }  // M int
        msg: 'OK',
        code: 0,
    }

/partner/update

更新加盟商

method
    POST
request
    id              M   int
    name            O   int
    description     O   int
    is_valid        O   bool (0 或 1)
    permission_ids  O   list of int 激活的权限 id
response
    { "code": 0, "msg": "OK", "data": null }

加盟商管理,按照权限查看

/partner/permission/search

搜索权限以及「激活这个权限的加盟商」

method
    GET
request
    level_1_id  int     O   一级权限的id,不传代表全部一级权限
    level_2_id  int     O   二级,同上
    search_text string  O   要搜索的权限名,不传代表全部
response
    {
        data: [
             {  
                id              M   int
                name            M   str
                level_1_name    M   str
                level_2_name    M   str
                partner_num     M   int     「激活这个权限的加盟商」的数量
                partner_names   M   str     「激活这个权限的加盟商」的名字们
             },
             ...
        ]
        msg: 'OK',
        code: 0,
    }

/partner/permission/detail

查看「激活某个权限的加盟商」

method
    GET
request
    permission_id               M   int
response
    {
        data: [
            partner_ids:    // M    list of int.    「激活这个权限的加盟商」的 id 们
        ]

        msg: 'OK',
        code: 0,
    }

/partner/permission/update

更新「激活这个权限的加盟商」

method
    POST
request
    permission_id   M   int
    partner_ids     M   list of int
response
    { "code": 0, "msg": "OK", "data": null }

站点管理,按照站点查看(同上)

/station/search

搜索站点

method
    GET
request
    partner_id      O   int
    search_txt      O   str
    station_type    O   int
    is_valid        O   int 是否激活,0 或 1
    offset          M   int default 0
    limit           M   int default 10
response
    {
        data: [
            {
                id              M   int
                name            M   str
                partner_name    M   str
                district_names  M   list of str
                station_type    M   int
                description     M   str
                created_date    M   str
                is_valid        M   bool
            },
            ...
        ],
        msg: 'OK',
        code: 0,
    }

/station/key/options

method
    GET
request
    station_id  M   str
response
    {
        data: [
                {
                    "key_url": "gm",
                    "name": "观麦界面(SaaS默认使用)"
                },
                {
                    "key_url": "jcgyl",
                    "name": "默认页面"
                },
                ...
            ]

    }

/station/payinfo/options

method
    GET
request
    station_id  M   str
response
    {
        data: 
            [
                {
                    "name": "观麦默认",
                    "id": "PAY0001"
                },
                {
                    "name": "K10蔬菜- 商品",
                    "id": "PAY0028"
                },
                ...
            ]

    }

/station/detail

站点详情

method
    GET
request
    id  M    int
response
    {
        data: {
            id                  M   int
            name                M   str
            partner_name        M   str
            station_type_id     M   int
            district_codes      M   list of int
            description         M   str
            receiver_name       M   str
            receiver_phone      M   str
            is_valid            M   bool
            wechat_pay_info : { M   dict
                appid           O   str 应用 id           如果用户没有配置,那么就不用传这个
                appsecret       O   str 应用秘钥            如果用户没有配置,那么就不用传这个
                mch_id          O   str 微信支付商户号         如果用户没有配置,那么就不用传这个
                key             O   str 商户支付密钥key        如果用户没有配置,那么就不用传这个
            }
            customized_info: {  M   dict
                cms_key:        O   str cms key     如果用户没有配置,那么就不用传这个
                appid           O   str 应用 id       如果用户没有配置,那么就不用传这个
                appsecret       O   str 应用秘钥        如果用户没有配置,那么就不用传这个
            }
            permisssion_ids:    M   list of int
            receive_begin_time  M   str 格式: %d:%d:%d
            receive_end_time    M   str 格式: %d:%d:%d
            address             M   str 收货地址
            enable_customized   M   1为激活个性化配置,0为关闭个性化配置
            enable_pay_info     M   1为激活微信支付, 0为关闭微信支付
            pay_info_id         O   str
            customized_info_id  O   str

        },
        msg: 'OK',
        code: 0,
    }

/station/create

创建站点

method
    POST
request
    name                M   str
    role                M   int
    distribute_cities   M   list of str 可配送城市
    receiver_name       M   str
    receiver_phone      M   str
    receive_begin_time  M   str 格式: %d:%d:%d
    receive_end_time    M   str 格式: %d:%d:%d
    address             M   str 收货地址
    station_type        M   int
    partner_id          M   int
    description         O   str
    wechat_pay_info : { O   dict
        appid           O   str 应用 id           如果用户没有配置,那么就不用传这个
        appsecret       O   str 应用秘钥            如果用户没有配置,那么就不用传这个
        mch_id          O   str 微信支付商户号         如果用户没有配置,那么就不用传这个
        key             O   str 商户支付密钥key        如果用户没有配置,那么就不用传这个
    }
    customized_info: {  O   dict
        cms_key:        O   str cms key     如果用户没有配置,那么就不用传这个
        appid           O   str 应用 id       如果用户没有配置,那么就不用传这个
        appsecret       O   str 应用秘钥        如果用户没有配置,那么就不用传这个
    }
    permisssion_ids:    O   list of int
    is_valid            M   1激活,0非激活
    enable_customized   M   1为激活个性化配置,0为关闭个性化配置
    enable_pay_info     M   1为激活微信支付, 0为关闭微信支付
    pay_info_id         O   str
    customized_info_id  O   str

response
    {
        data: { id: 123 }  // M int 用户 id
        msg: 'OK',
        code: 0,
    }

/station/update

更新站点

method
    POST
request
    id                  M   int
    distribute_cities   O   list of str 可配送城市
    receiver_name       O   str
    receiver_phone      O   str
    receive_begin_time  O   str 格式: %d:%d:%d
    receive_end_time    O   str 格式: %d:%d:%d
    address             O   str 收货地址
    station_type        O   int
    wechat_pay_info : { O   dict  不传的话表示不修改,传空字典的话表示删除 appid 等数据
        id              O   pay_info_id
        appid           O   str 应用 id           如果用户没有配置,那么就不用传这个
        appsecret       O   str 应用秘钥            如果用户没有配置,那么就不用传这个
        mch_id          O   str 微信支付商户号         如果用户没有配置,那么就不用传这个
        key             O   str 商户支付密钥key        如果用户没有配置,那么就不用传这个
    }
    customized_info: {  O   dict  不传的话表示不修改,传空字典的话表示删除 appid 等数据
        cms_key:        O   str cms key     如果用户没有配置,那么就不用传这个
        appid           O   str 应用 id       如果用户没有配置,那么就不用传这个
        appsecret       O   str 应用秘钥        如果用户没有配置,那么就不用传这个
    }
    permisssion_ids:    O   list of int
    is_valid            M   1代表激活,0代表未激活
    enable_customized   M   1为激活个性化配置,0为关闭个性化配置
    enable_pay_info     M   1为激活微信支付, 0为关闭微信支付
    pay_info_id         O   str
    customized_info_id  O   str
response
    { "code": 0, "msg": "OK", "data": null }

站点管理,按照权限查看

/station/permission/search

搜索权限以及「激活这个权限的站点」

method
    GET
request
    level_1_id  int     O   一级权限的id,不传代表全部一级权限
    level_2_id  int     O   二级,同上
    search_text string  O   要搜索的权限名,不传代表全部
response
    {
        data: 
            [
                {
                    id:             M   int 权限 id
                    name:           M   str 权限 名字
                    level_1_name:     M
                    level_2_name:     M
                    station_names:  O   list of str 「激活这个权限的站点」的名字们
                    station_count:  O   int         「激活这个权限的站点」的数量
                },
                ...

            ]
        ,
        msg: 'OK',
        code: 0,
    }

/station/permission/detail

搜索某个权限

method
    GET
request
    permission_id   M   int
response
    [
        id  # station_id        M   int
    ]

/station/permission/update

method
    GET
request
    permission_id   M   int
    station_ids     M   list of int
response
    { "code": 0, "msg": "OK", "data": null }

加盟商管理员

/partner_administrator/search

method
    GET
request
    search_text     O   str
    limit           M   int default 10
    offset          M   int default 0
response
    {
        data: [
            {
                id              M   int
                username        M   str
                partner_name    M   str
                name            M   str
                phone           M   str
                create_date     M   str
            }
        ]
        msg: 'OK'
        code: 0
    }

/partner_administrator/detail

method
    GET
request
    id          M   int
response
    {
        data: {
            id          M   int
            partner_id  M   int
            name        M   str
            username    M   str
            phone       M   str
            email       M   str
        }
        msg: 'OK'
        code: 0
    }

/partner_administrator/create

method
    POST
request
    partner_id          M   int 加盟商 id
    username    M   str 用户名
    name        O   str 姓名
    phone       O   str
    email       O   str
    password    M   str 明文密码
response
    {
        data: { id: 123 }  // M int
        msg: 'OK',
        code: 0,
    }

/partner_administrator/update

method
    POST
request
    id          M   int  管理员id
    partner_id  M   int  加盟商id
    name        O   str
    phone       O   str
    email       O   str
    password    O   str 明文密码
response
    { "code": 0, "msg": "OK", "data": null }

/partner_administrator/change_password

method
    POST
request
    id  M   int     加盟商管理员 id
    password  M  str   密码
response
    { "code": 0, "msg": "OK", "data": null }